home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / machserver / 1.098 / include / rpc / auth.h < prev    next >
C/C++ Source or Header  |  1989-01-25  |  5KB  |  156 lines
  1. /* @(#)auth.h    1.2 87/11/23 3.9 RPCSRC */
  2. /*
  3.  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  4.  * unrestricted use provided that this legend is included on all tape
  5.  * media and as a part of the software program in whole or part.  Users
  6.  * may copy or modify Sun RPC without charge, but are not authorized
  7.  * to license or distribute it to anyone else except as part of a product or
  8.  * program developed by the user.
  9.  * 
  10.  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11.  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12.  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13.  * 
  14.  * Sun RPC is provided with no support and without any obligation on the
  15.  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16.  * modification or enhancement.
  17.  * 
  18.  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19.  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20.  * OR ANY PART THEREOF.
  21.  * 
  22.  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23.  * or profits or other special, indirect and consequential damages, even if
  24.  * Sun has been advised of the possibility of such damages.
  25.  * 
  26.  * Sun Microsystems, Inc.
  27.  * 2550 Garcia Avenue
  28.  * Mountain View, California  94043
  29.  */
  30. /*      @(#)auth.h 1.16 87/10/01 SMI      */
  31.  
  32. /*
  33.  * auth.h, Authentication interface.
  34.  *
  35.  * Copyright (C) 1984, Sun Microsystems, Inc.
  36.  *
  37.  * The data structures are completely opaque to the client.  The client
  38.  * is required to pass a AUTH * to routines that create rpc
  39.  * "sessions".
  40.  */
  41.  
  42.  
  43. #define MAX_AUTH_BYTES    400
  44. #define MAXNETNAMELEN    255    /* maximum length of network user's name */
  45.  
  46. /*
  47.  * Status returned from authentication check
  48.  */
  49. enum auth_stat {
  50.     AUTH_OK=0,
  51.     /*
  52.      * failed at remote end
  53.      */
  54.     AUTH_BADCRED=1,            /* bogus credentials (seal broken) */
  55.     AUTH_REJECTEDCRED=2,        /* client should begin new session */
  56.     AUTH_BADVERF=3,            /* bogus verifier (seal broken) */
  57.     AUTH_REJECTEDVERF=4,        /* verifier expired or was replayed */
  58.     AUTH_TOOWEAK=5,            /* rejected due to security reasons */
  59.     /*
  60.      * failed locally
  61.     */
  62.     AUTH_INVALIDRESP=6,        /* bogus response verifier */
  63.     AUTH_FAILED=7            /* some unknown reason */
  64. };
  65.  
  66. #if (mc68000 || sparc || vax || i386)
  67. typedef u_long u_int32;    /* 32-bit unsigned integers */
  68. #endif
  69.  
  70. /*
  71.  * Authentication info.  Opaque to client.
  72.  */
  73. struct opaque_auth {
  74.     enum_t    oa_flavor;        /* flavor of auth */
  75.     caddr_t    oa_base;        /* address of more auth stuff */
  76.     u_int    oa_length;        /* not to exceed MAX_AUTH_BYTES */
  77. };
  78.  
  79.  
  80. /*
  81.  * Auth handle, interface to client side authenticators.
  82.  */
  83. typedef struct {
  84.     struct    opaque_auth    ah_cred;
  85.     struct    opaque_auth    ah_verf;
  86.     struct auth_ops {
  87.         void    (*ah_nextverf)();
  88.         int    (*ah_marshal)();    /* nextverf & serialize */
  89.         int    (*ah_validate)();    /* validate varifier */
  90.         int    (*ah_refresh)();    /* refresh credentials */
  91.         void    (*ah_destroy)();    /* destroy this structure */
  92.     } *ah_ops;
  93.     caddr_t ah_private;
  94. } AUTH;
  95.  
  96.  
  97. /*
  98.  * Authentication ops.
  99.  * The ops and the auth handle provide the interface to the authenticators.
  100.  *
  101.  * AUTH    *auth;
  102.  * XDR    *xdrs;
  103.  * struct opaque_auth verf;
  104.  */
  105. #define AUTH_NEXTVERF(auth)        \
  106.         ((*((auth)->ah_ops->ah_nextverf))(auth))
  107. #define auth_nextverf(auth)        \
  108.         ((*((auth)->ah_ops->ah_nextverf))(auth))
  109.  
  110. #define AUTH_MARSHALL(auth, xdrs)    \
  111.         ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  112. #define auth_marshall(auth, xdrs)    \
  113.         ((*((auth)->ah_ops->ah_marshal))(auth, xdrs))
  114.  
  115. #define AUTH_VALIDATE(auth, verfp)    \
  116.         ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  117. #define auth_validate(auth, verfp)    \
  118.         ((*((auth)->ah_ops->ah_validate))((auth), verfp))
  119.  
  120. #define AUTH_REFRESH(auth)        \
  121.         ((*((auth)->ah_ops->ah_refresh))(auth))
  122. #define auth_refresh(auth)        \
  123.         ((*((auth)->ah_ops->ah_refresh))(auth))
  124.  
  125. #define AUTH_DESTROY(auth)        \
  126.         ((*((auth)->ah_ops->ah_destroy))(auth))
  127. #define auth_destroy(auth)        \
  128.         ((*((auth)->ah_ops->ah_destroy))(auth))
  129.  
  130.  
  131. extern struct opaque_auth _null_auth;
  132.  
  133.  
  134. /*
  135.  * These are the various implementations of client side authenticators.
  136.  */
  137.  
  138. /*
  139.  * Unix style authentication
  140.  * AUTH *authunix_create(machname, uid, gid, len, aup_gids)
  141.  *    char *machname;
  142.  *    int uid;
  143.  *    int gid;
  144.  *    int len;
  145.  *    int *aup_gids;
  146.  */
  147. extern AUTH *authunix_create();
  148. extern AUTH *authunix_create_default();    /* takes no parameters */
  149. extern AUTH *authnone_create();        /* takes no parameters */
  150.  
  151. #define AUTH_NONE    0        /* no authentication */
  152. #define    AUTH_NULL    0        /* backward compatibility */
  153. #define    AUTH_UNIX    1        /* unix style (uid, gids) */
  154. #define    AUTH_SHORT    2        /* short hand unix style */
  155. #define AUTH_DES    3        /* des style (encrypted timestamps) */
  156.